ネット銀聯決済 API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様(.idPass)

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200:常に200を返却

EntryTranUnionpay 取引登録

取引IDと取引パスワードの発行を行い、取引を開始します。
※ネット銀聯決済では、仮売上(AUTH)が成功した場合でも、その後の通貨レート変動の影響により、実売上がエラーとなる場合があります。
このため、当社では仮売上/実売上の使用を推奨しておりません。即時売上(CAPTURE)の使用をお勧めします。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

JobCd 必須
処理区分

AUTH:仮売上
CAPTURE:即時売上

Amount 必須 半角数字8桁
利用金額

Tax 半角数字7桁
税送料

税送料を指定した場合は、利用金額+税送料が決済金額となります。

URL
/payment/EntryTranUnionpay.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=100
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
OrderID=ORDER0000001&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranUnionpay 決済実行

決済取引で必要となるトークンと遷移URLを返却します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

CommodityName 半角英数255桁
商品名

半角英数+記号(マイナス、アンダーライン、ドット、半角スペース)のみ使用可能です。

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

ClientFieldFlag 半角数字1桁 固定
加盟店自由項目返却フラグ

以下のいずれかを設定します。
0:返却しない(デフォルト)
1:返却する

RetURL 必須 半角英数記号2048桁
決済結果戻しURL

加盟店様が当サービスから決済結果を受信する結果受信URLを設定します。
お客様が決済手続きを正常に完了された場合、指定されたURLに結果をリダイレクト経由で送信されます。

ErrorRcvURL 必須 半角英数記号2048桁
処理NG時URL

加盟店様が当サービスから処理失敗となった結果を受信する処理NG時URLを設定します。
お客様が決済手続きを正常に完了できなかった場合、指定されたURLに結果をリダイレクト経由で送信されます。

URL
/payment/ExecTranUnionpay.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive/success&ErrorRcvURL=https://example.com/receive/error
レスポンス
正常
AccessID 半角英数32桁 固定
取引ID

Token 半角英数記号256桁
トークン

StartURL 半角英数記号256桁
支払手続き開始IFのURL

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=wpd8A+R8uWZt+GnF6auJtMZNSB4yzSCZR9xdztqdBjGwBS7yYvxSiC0zeMVH+O4F&StartURL=https://x01.mul-pay.jp/payment/UnionpayStart.idPass
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

UnionpayStart 支払手続き開始IFの呼び出し

お客様をネット銀聯の決済画面へ遷移させる必要があります。 ※取引が特定できない場合、すでに支払いを済ませている場合、支払期限切れの場合等はエラー画面を表示します。

リクエスト
AccessID 必須 半角英数32桁 固定
取引ID

Token 必須 半角英数記号256桁
トークン

リダイレクトページサンプル
<html>
      <head>
      <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
      </head>
      <body OnLoad='OnLoadEvent();'>
      <form name="UnionpayStartCall" action="{決済実行のレスポンスで返却した接続先URL}" method="POST">
        <noscript>
          <br>
          <br>
          <center>
            <h2>ネット銀聯の決済画面へ遷移します。</h2>
            <input type="submit" value="続行">
          </center>
        </noscript>
        <input type="hidden" name="AccessID" value="{AccessID}">
        <input type="hidden" name="Token" value="{Token}">
      </form>
      <script>
    <!--
    function OnLoadEvent() {
    document.UnionpayStartCall.submit();
    }
    //-->
      </script>
      </body>
    </html>

リダイレクト後、お客様はネット銀聯ログイン画面へ遷移します。

決済結果受信

ネット銀聯決済から、当サービスに支払操作結果が通知されます。
支払操作結果は、お客様が支払操作を完了した場合と支払操作をキャンセルした場合(オプション)に通知されます。
※ブラウザを×ボタンで閉じた場合は、通知されません。
当サービスは、【決済実行】時に指定されたリダイレクトURLに決済結果を通知します。

レスポンス
正常
ShopID 半角英数13桁
ショップID

OrderID 半角英数記号27桁
オーダーID

Status
現状態

該当取引の取引状態を返却します。
AUTH:仮売上
CAPTURE:即時売上
PAYFAIL:決済失敗

TranDate 半角数字14桁 固定
処理日時

yyyyMMddHHmmss形式

ClientField1 全半角100バイト
加盟店自由項目1

【決済実行】で加盟店自由項目返却フラグに 1:返却する が指定された場合のみ返却します。

ClientField2 全半角100バイト
加盟店自由項目2

【決済実行】で加盟店自由項目返却フラグに 1:返却する が指定された場合のみ返却します。

ClientField3 全半角100バイト
加盟店自由項目3

【決済実行】で加盟店自由項目返却フラグに 1:返却する が指定された場合のみ返却します。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード

UnionpayCancel キャンセル

決済内容のキャンセルを行います。 ※本インタフェースは、決済のキャンセル要求を行い要求結果を返します。  キャンセル処理の実行結果は別途結果通知にて返却されます。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

URL
/payment/UnionpayCancel.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

Status
現状態

処理成功時は以下のステータスが返却されます。
・REQCANCEL:キャンセル要求中

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
OrderID=ORDER0000001&Status=REQCANCEL
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

UnionpayReturn 返品

即時売上、実売上の取引に対して決済内容の返品を行います。 ※本インタフェースは、決済の返品要求を行い要求結果を返します。  返品処理の実行結果は別途結果通知にて返却されます。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

CancelAmount 必須 半角数字8桁
返品金額

返品金額+返品税送料を返品金額とします。(1円以上)
売上確定金額の一部返品が可能です。

例)実売上525円より210円分返品
→返品金額:210
例)実売上525円を全額返品
→返品金額:525

CancelTax 半角数字7桁
返品税送料

返品金額+返品税送料を返品金額とします。(1円以上)
売上確定金額の一部返品が可能です。

例)実売上525円より210円分返品
→返品金額:210
例)実売上525円を全額返品
→返品金額:525

URL
/payment/UnionpayReturn.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CancelAmount=100
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

Status
現状態

処理成功時は以下のステータスが返却されます。
・REQRETURN:返品要求

一部返品時は返品処理前のステータスが返却されます。

Amount 半角数字8桁
利用金額

利用金額から返品金額を減算した結果を返却します。

例)利用金額5,000円より返品金額3,000円 => 利用金額2,000円

Tax 半角数字7桁
税送料

税送料から返品税送料を減算した結果を返却します。

例)税送料250円より返品税送料150円
=> 税送料100円

CancelAmount 半角数字8桁
返品金額

CancelTax 半角数字7桁
返品税送料

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
OrderID=ORDER0000001&Status=REQRETURN&Amount=50&Tax=&CancelAmount=50&CancelTax=
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

UnionpaySales 実売上

仮売上の決済に対して実売上を行います。 ※本インタフェースは、決済の実売上要求を行い要求結果を返します。
実売上処理の実行結果は別途結果通知にて返却されます。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

Amount 必須 半角数字8桁
利用金額

利用金額+税送料が売上金額となります(1円以上)
※0円の場合はエラーとします。
※オーソリ時より大きい金額の場合はエラーとします。
※オーソリ時と異なる金額の場合は、指定された金額で売上を確定します。

Tax 半角数字7桁
税送料

利用金額+税送料が売上金額となります(1円以上)
※0円の場合はエラーとします。
※オーソリ時より大きい金額の場合はエラーとします。
※オーソリ時と異なる金額の場合は、指定された金額で売上を確定します。

URL
/payment/UnionpaySales.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=100
レスポンス
正常
AccessID 半角英数32桁 固定
取引ID

Status
現状態

処理時は以下のステータスが返却されます。
・REQSALES:実売上

Amount 半角数字8桁
利用金額

Tax 半角数字7桁
税送料

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&Status=REQSALES&Amount=100&Tax=0
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

指定したオーダーIDの取引情報を取得します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

PayType 必須 半角数字2桁
決済方法

21:ネット銀聯決済

URL
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=21
レスポンス
正常
Status
現状態

UNPROCESSED:未決済
REQSUCCESS:要求成功
PAYSTART:決済開始
PAYFAIL:決済失敗
EXPIRED:期限切れ
AUTH:仮売上
CAPTURE:即時売上
REQSALES:実売上要求中
REQRETURN:返品要求中
REQCANCEL:キャンセル要求中
SALES:実売上
RETURN:返品
CANCEL:キャンセル

ProcessDate 半角数字14桁 固定
処理日時

yyyyMMddHHmmss形式

JobCd
処理区分

CAPTURE:即時売上
AUTH:仮売上
SALES:実売上
RETURN_CAPTURE:返品(即時売上)
RETURN_SALES:返品(実売上)
CANCEL_CAPTURE:キャンセル(即時売上)
CANCEL_SALES:キャンセル(実売上)
CANCEL_AUTH:キャンセル(仮売上)

AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

Amount 半角数字8桁
利用金額

Tax 半角数字7桁
税送料

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

PayType 半角数字2桁
決済方法

21:ネット銀聯決済

CommodityName 半角英数255桁
商品名

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
Status=AUTH&ProcessDate=20220801121212&JobCd=AUTH&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=100&Tax=0&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PayType=21&CommodityName=商品名
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001